package uy.org.softtech.cssuite.entidad.finanzas;

import static uy.org.softtech.cssuite.entidad.Entidad.FINANZAS_NAMESPACE;
import static uy.org.softtech.cssuite.helpers.HelperFechaHora.fechaLarga;
import static uy.org.softtech.cssuite.helpers.HelperFinanzas.formatearImporte;

import java.io.Serializable;
import java.math.BigDecimal;
import java.util.Date;
import java.util.Set;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.OrderBy;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlType;

import org.codehaus.jackson.annotate.JsonBackReference;
import org.codehaus.jackson.annotate.JsonIgnore;
import org.codehaus.jackson.annotate.JsonManagedReference;
import org.codehaus.jackson.annotate.JsonProperty;
import org.codehaus.jackson.map.annotate.JsonRootName;
import org.codehaus.jackson.map.annotate.JsonSerialize;
import org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion;
import org.hibernate.annotations.Fetch;
import org.hibernate.annotations.FetchMode;
import org.hibernate.annotations.ForeignKey;

import uy.org.softtech.cssuite.entidad.Entidad;
import uy.org.softtech.cssuite.helpers.HelperFechaHora;
import uy.org.softtech.cssuite.helpers.HelperFinanzas;

/**
 * <p>Entidad que representa a un pago en la cuenta de cliente. También mapea la declaración del tipo de dato XML 'pago'.</p>
 * 
 * <p>El siguiente fragmento de esquema especifica el contenido esperado y representado por los atributos de esta clase.</p>
 *  
 * <pre>
 * &lt;xsd:complexType name="pago">
 *  &lt;xsd:all>
 *   &lt;xsd:element name="id" tipo="xsd:ID"/>
 *   &lt;xsd:element name="metodo" tipo="{http://cssuite.softtech.org.uy/esquemas/tipos}metodoPago"/>
 *   &lt;xsd:element name="estado" tipo="{http://cssuite.softtech.org.uy/esquemas/tipos}estadoPago"/>
 *   &lt;xsd:element name="tipo" tipo="{http://cssuite.softtech.org.uy/esquemas/tipos}tipoPago"/>
 *   &lt;xsd:element name="fecha" tipo="xsd:dateTime"/>
 *   &lt;xsd:element name="monto" tipo="xsd:double" default="0.00" />
 *   &lt;xsd:element name="disponible" tipo="xsd:double" default="0.00" />
 *   &lt;xsd:element name="comentarios" tipo="{http://cssuite.softtech.org.uy/esquemas/tipos}comentario" minOccurs="0"/>
 *   &lt;xsd:element name="movimientos">
 *    &lt;xsd:complexType>
 *     &lt;xsd:sequence>
 *      &lt;xsd:element name="movimiento" tipo="movimiento" minOccurs="0" maxOccurs="unbounded" />
 *     &lt;/xsd:sequence>
 *    &lt;/xsd:complexType>
 *   &lt;/xsd:element>
 *  &lt;/xsd:all>
 * &lt;/xsd:complexType>
 * 
 * </pre>
 *
 * @author fabian.lobo
 */
@Entity
@JsonRootName(value = "pago")
@JsonSerialize(include = Inclusion.NON_NULL)
@Table(name = "CSS_PAGO")
@XmlType(name = "pago", namespace = FINANZAS_NAMESPACE, propOrder = {})
public class Pago extends Entidad implements Serializable {
	
	private static final long serialVersionUID = 4868473588711590114L;
	
	/**
	 * Enumerado para agrupar los diferentes métodos de pago.
	 * 
	 * @author fabian.lobo
	 */
	@XmlEnum
	@XmlType(name = "metodoPago", namespace = FINANZAS_NAMESPACE)
	public enum Metodo {
		CHEQUE, EFECTIVO, GIRO_POSTAL, TARJETA, TRANSFERENCIA;
	}

	/**
	 * Enumerado para agrupar los diferentes estados de pago.
	 * 
	 * @author fabian.lobo
	 */
	@XmlEnum
	@XmlType(name = "estadoPago", namespace = FINANZAS_NAMESPACE)
	public enum Estado {
		CANCELADO, COBRADO, DISPONIBLE, GENERADO, PENDIENTE, RECHAZADO, USADO;
	}
	
	/**
	 * Enumerado para agrupar los diferentes tipos de pago.
	 * 
	 * @author fabian.lobo
	 */
	@XmlEnum
	@XmlType(name = "tipoPago", namespace = FINANZAS_NAMESPACE)
	public enum Tipo {
		CHEQUE, CREDITO, DEBITO, EFECTIVO, GIRO, TRANSFERENCIA;
	}
	
	@Id
	@GeneratedValue(strategy = GenerationType.AUTO)
	@Column(name = "ID_PAGO")
	private Long id;
	
	@Column(name = "ESTADO", nullable = false, length = 10)
	@Enumerated(EnumType.STRING)
	private Estado estado;
	
	@Column(name = "TIPO_PAGO", nullable = false, length = 20)
	@Enumerated(EnumType.STRING)
	private Tipo tipo;
	
	@Column(name = "METODO_PAGO", nullable = false, length = 20)
	@Enumerated(EnumType.STRING)
	private Metodo metodo;
	
	@Column(name = "FECHA", nullable = false)
	@JsonIgnore
	@Temporal(TemporalType.TIMESTAMP)
	private Date fecha;
	
	@Column(name = "MONTO", nullable = false, precision = 10, scale = 2)
	@JsonIgnore
	private BigDecimal monto = new BigDecimal("0.00");
	
	@Column(name = "DISPONIBLE", nullable = false, precision = 10, scale = 2)
	@JsonIgnore
	private BigDecimal disponible = new BigDecimal("0.00");
	
	@Column(name = "COMENTARIOS", nullable = true, length = 500)
	private String comentarios;
	
	@JsonBackReference
	@ManyToOne(optional = false, fetch = FetchType.EAGER)
	@JoinColumn(name = "ID_CUENTA", nullable = false)
	@ForeignKey(name = "FK_PAGO_CUENTA")
	private Cuenta cuenta;
	
	@JsonManagedReference
	@OneToMany(fetch = FetchType.EAGER, cascade = CascadeType.ALL, mappedBy = "pago")
	@Fetch(FetchMode.SUBSELECT)
	@OrderBy(value = "fecha DESC, id DESC")
	@XmlElementWrapper(name = "movimientos", namespace = FINANZAS_NAMESPACE, required = true)
	@XmlElement(name = "movimiento", namespace = FINANZAS_NAMESPACE, required = true)
	private Set<Movimiento> movimientos;
	
	/*
	 *  GETTERS
	 */
	public Long getId() {
		return id;
	}
	public Estado getEstado() {
		return estado;
	}
	public Tipo getTipo() {
		return tipo;
	}
	public Metodo getMetodo() {
		return metodo;
	}
	public Date getFecha() {
		return fecha;
	}
	public BigDecimal getMonto() {
		return monto;
	}
	public BigDecimal getDisponible() {
		return disponible;
	}
	public String getComentarios() {
		return comentarios;
	}
	public Cuenta getCuenta() {
		return cuenta;
	}
	public Set<Movimiento> getMovimientos() {
		return movimientos;
	}
	
	/*
	 *  SETTERS
	 */
	public void setId(Long id) {
		this.id = id;
	}
	public void setEstado(Estado estado) {
		this.estado = estado;
	}
	public void setTipo(Tipo tipo) {
		this.tipo = tipo;
	}
	public void setMetodo(Metodo metodo) {
		this.metodo = metodo;
	}
	public void setFecha(Date fecha) {
		this.fecha = fecha;
	}
	public void setMonto(BigDecimal monto) {
		this.monto = monto;
	}
	public void setDisponible(BigDecimal disponible) {
		this.disponible = disponible;
	}
	public void setComentarios(String comentarios) {
		this.comentarios = comentarios;
	}
	public void setCuenta(Cuenta cuenta) {
		this.cuenta = cuenta;
	}
	public void setMovimientos(Set<Movimiento> movimientos) {
		this.movimientos = movimientos;
	}
	
	/*
	 *  CONVERSORES
	 */
	/**
	 * Convierte la fecha del pago a texto
	 * 
	 * @author fabian.lobo
	 * @see HelperFechaHora#fechaLarga()
	 */
	@JsonProperty(value = "fecha")
	public String convierteFecha() {
		return fechaLarga(getFecha());
	}
	
	/**
	 * Convierte el importe del pago a texto
	 * 
	 * @author fabian.lobo
	 * @see HelperFinanzas#formatearImporte()
	 */
	@JsonProperty(value = "monto")
	public String convierteMonto() {
		return formatearImporte(getMonto());
	}
	
	/**
	 * Convierte el importe disponible a texto
	 * 
	 * @author fabian.lobo
	 * @see HelperFinanzas#formatearImporte()
	 */
	@JsonProperty(value = "disponible")
	public String convierteDisponible() {
		return formatearImporte(getDisponible());
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 9;
		result = prime * result + ((getId() == null) ? 0 : getId().hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		Pago otro = (Pago) obj;
		if (id != null && otro.id != null && id.equals(otro.id)) {
			return true;
		}
		return false;
	}

	@Override
	public String toString() {
		StringBuilder builder = new StringBuilder();
		builder.append("Pago [");
		builder.append("id=" + getId() + ", ");
		builder.append("estado=" + getEstado() + ", ");
		builder.append("tipo=" + getTipo() + ", ");
		builder.append("metodo=" + getMetodo() + ", ");
		builder.append("fecha" + convierteFecha() + ", ");
		builder.append("monto" + convierteMonto() + ", ");
		builder.append("disponible" + convierteDisponible() + ", ");
		builder.append("comentarios=" + getComentarios());
		builder.append("]");
		return builder.toString();
	}

	@Override
	public String toString(boolean incluirColecciones) {
		StringBuilder result = new StringBuilder(toString());
		
		if(incluirColecciones) {
			int offset = result.length() - 2;
			StringBuilder builder = new StringBuilder(", ");
			builder.append("movimientos=" + getMovimientos());
			result.insert(offset, builder.toString());
		}	
				
		return result.toString();
	}

}
